/*
* MIT License
*
* Copyright (c) 2017 wen.gu <454727014@qq.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

/***************************************************************************
* Name: tiny_compoent.h
*
* Purpose: the base data structure of component
*
* Developer:
*   wen.gu , 2018-08-22
*
* TODO:
*
***************************************************************************/

#ifndef __TINY_COMPONENT_H__
#define __TINY_COMPONENT_H__

#include "general_type.h"

#ifdef __cplusplus
extern "C" {
#endif

/***************************************************************************
*
* macro declaration
*
***************************************************************************/

/** a helper macro to release component
    *  define componnt data structure must like this
    *  typedef struct test_component_s
    *  {
    *      tiny_component_t comp; // the name must "comp"
    *      //this component's interface
    *  }test_component_t;
    */
#define TF_COMP_RELEASE(comp) \
        do{\
            tiny_component_t* _tc = ((tiny_component_t*)comp); \
            if (_tc && _tc->release){\
                _tc->release(_tc); \
            } \
        }while(0)
/***************************************************************************
*
* data struct declaration
*
***************************************************************************/

/** the base parameter of create component instance */
typedef struct tiny_comp_create_param_s
{
    GU32 type; /** the type component */
}tiny_comp_create_param_t;

/** "base class" of component */

typedef struct tiny_component_s tiny_component_t;

struct tiny_component_s
{
    GSTR name; /** the name of component */
    GSTR version; /** the version of component */

    /** the member function to release the instance of component */
    void(*release)(tiny_component_t* comp); 
};
/***************************************************************************
*
* API declaration
*
***************************************************************************/

#ifdef __cplusplus
}
#endif


#endif /** !__TINY_COMPONENT_H__*/
